<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hdmitxss: xv_hdmitxss_log.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hdmitxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xv__hdmitxss__log_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xv_hdmitxss_log.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   YH   17/08/16 Initial release.
1.01  MMO  03/01/17 Add compiler option(XV_HDMITXSS_LOG_ENABLE) to enable Log
5.0   EB   16/01/18 Added new log XV_HDMITXSS_LOG_EVT_PIX_REPEAT_ERR
           23/01/18 Minor cleanup
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af956a862c4edf0e7a47b832875337a7c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss__log_8c.html#af956a862c4edf0e7a47b832875337a7c">XV_HdmiTxSs_LogReset</a> (<a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:af956a862c4edf0e7a47b832875337a7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will reset the driver's logging mechanism.  <a href="#af956a862c4edf0e7a47b832875337a7c">More...</a><br/></td></tr>
<tr class="separator:af956a862c4edf0e7a47b832875337a7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0c1b30d849344a197178cf8316fa9b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss__log_8c.html#ad0c1b30d849344a197178cf8316fa9b3">XV_HdmiTxSs_LogWrite</a> (<a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *InstancePtr, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923f">XV_HdmiTxSs_LogEvent</a> Evt, u8 Data)</td></tr>
<tr class="memdesc:ad0c1b30d849344a197178cf8316fa9b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will insert an event in the driver's logginc mechanism.  <a href="#ad0c1b30d849344a197178cf8316fa9b3">More...</a><br/></td></tr>
<tr class="separator:ad0c1b30d849344a197178cf8316fa9b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ed5157a8dbfe946f4a762d6c23ab4d"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss__log_8c.html#ae6ed5157a8dbfe946f4a762d6c23ab4d">XV_HdmiTxSs_LogRead</a> (<a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ae6ed5157a8dbfe946f4a762d6c23ab4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will read the last event from the log.  <a href="#ae6ed5157a8dbfe946f4a762d6c23ab4d">More...</a><br/></td></tr>
<tr class="separator:ae6ed5157a8dbfe946f4a762d6c23ab4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b6a0f4217d55b3b46138ff6e2f8b43c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss__log_8c.html#a4b6a0f4217d55b3b46138ff6e2f8b43c">XV_HdmiTxSs_LogDisplay</a> (<a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a4b6a0f4217d55b3b46138ff6e2f8b43c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will print the entire log.  <a href="#a4b6a0f4217d55b3b46138ff6e2f8b43c">More...</a><br/></td></tr>
<tr class="separator:a4b6a0f4217d55b3b46138ff6e2f8b43c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a4b6a0f4217d55b3b46138ff6e2f8b43c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs_LogDisplay </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will print the entire log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___hdmi_tx_ss.html" title="The XVprocss driver instance data. ">XV_HdmiTxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa19e64376a7bc0d075b83973978edef13">XV_HDMITXSS_LOG_EVT_AUDIOMUTE</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa37b0da525fa11fcbf2c2b03f2218feab">XV_HDMITXSS_LOG_EVT_AUDIOUNMUTE</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fae56a3c83db8aaa525d32d89671482314">XV_HDMITXSS_LOG_EVT_BRDG_UNLOCKED</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa21a658fbdda5fa3242ab9fce028ac989">XV_HDMITXSS_LOG_EVT_CONNECT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa52b70a5c9223ccf7b7f010c33c369a01">XV_HDMITXSS_LOG_EVT_DISCONNECT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fae944cb76b310e5c8f7b62c75b6fd268e">XV_HDMITXSS_LOG_EVT_HDCP14_AUTHREQ</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fad36db8488d373de8ef137732e488c450">XV_HDMITXSS_LOG_EVT_HDCP14_INIT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa6e7f95d49b59cb67f095b3fc4c018bdc">XV_HDMITXSS_LOG_EVT_HDCP22_AUTHREQ</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa42ed1e8b2778b13b1d9b5a539fabe446">XV_HDMITXSS_LOG_EVT_HDCP22_INIT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa55f643d6793199a8740bd86a1f2b3b4f">XV_HDMITXSS_LOG_EVT_HDCPTIMER_INIT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa4f4316b36f2b9dd8ca8c690b85cf3d2a">XV_HDMITXSS_LOG_EVT_HDMITX_INIT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fac813131aeec985f9950e3e043aec6dfb">XV_HDMITXSS_LOG_EVT_NONE</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fad2f745553ef25a196a3124d61ab5f200">XV_HDMITXSS_LOG_EVT_PIX_REPEAT_ERR</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923faabc0081f0faac3c6a35b5f00bc333034">XV_HDMITXSS_LOG_EVT_RESET</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa087b48b31d7842de475f02f12d7fb94c">XV_HDMITXSS_LOG_EVT_SETAUDIOCHANNELS</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa8fb637e23218a57370815d8e3bf545f4">XV_HDMITXSS_LOG_EVT_SETSTREAM</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fa2422e5833cbf1544e791290de2f492c2">XV_HDMITXSS_LOG_EVT_START</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923faf0e0ed981aafee6c5024e790716f69ab">XV_HDMITXSS_LOG_EVT_STOP</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fabe81a44a5b299e84d20e2f64e48bf035">XV_HDMITXSS_LOG_EVT_STREAMDOWN</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fad199785b3d891509408dbb8e6798e3a0">XV_HDMITXSS_LOG_EVT_STREAMSTART</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fac562e56b76d0618dfc7b7c36882583cc">XV_HDMITXSS_LOG_EVT_STREAMUP</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fac3c88a5c3acdf6ea214db9c327be748f">XV_HDMITXSS_LOG_EVT_TOGGLE</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923faf132ed593a82d089eb70072e679eb6d7">XV_HDMITXSS_LOG_EVT_VTC_INIT</a>, <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923fafca459a3730bab2094fc6f08728d9fd9">XV_HDMITXSS_LOG_EVT_VTC_RES_ERR</a>, and <a class="el" href="xv__hdmitxss_8h.html#ae6ed5157a8dbfe946f4a762d6c23ab4d">XV_HdmiTxSs_LogRead()</a>.</p>

</div>
</div>
<a class="anchor" id="ae6ed5157a8dbfe946f4a762d6c23ab4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XV_HdmiTxSs_LogRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will read the last event from the log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___hdmi_tx_ss.html" title="The XVprocss driver instance data. ">XV_HdmiTxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The log data.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ac51c010acb0091ab655be202551c7d14">XV_HdmiTxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ad9c78a413b5caeb99479edc9808799a9">XV_HdmiTxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___hdmi_tx_ss.html#a17215ebaf9a0c87b8fa10c72ae86eb6b">XV_HdmiTxSs::Log</a>, and <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ac6f3a5bc861229dc3ed8868f5afbc1e5">XV_HdmiTxSs_Log::TailIndex</a>.</p>

<p>Referenced by <a class="el" href="xv__hdmitxss__log_8c.html#a4b6a0f4217d55b3b46138ff6e2f8b43c">XV_HdmiTxSs_LogDisplay()</a>.</p>

</div>
</div>
<a class="anchor" id="af956a862c4edf0e7a47b832875337a7c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs_LogReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will reset the driver's logging mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the xv_hdmitxss core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ad9c78a413b5caeb99479edc9808799a9">XV_HdmiTxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___hdmi_tx_ss.html#a17215ebaf9a0c87b8fa10c72ae86eb6b">XV_HdmiTxSs::Log</a>, and <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ac6f3a5bc861229dc3ed8868f5afbc1e5">XV_HdmiTxSs_Log::TailIndex</a>.</p>

</div>
</div>
<a class="anchor" id="ad0c1b30d849344a197178cf8316fa9b3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs_LogWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_tx_ss.html">XV_HdmiTxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923f">XV_HdmiTxSs_LogEvent</a>&#160;</td>
          <td class="paramname"><em>Evt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will insert an event in the driver's logginc mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___hdmi_tx_ss.html" title="The XVprocss driver instance data. ">XV_HdmiTxSs</a> core instance. </td></tr>
    <tr><td class="paramname">Evt</td><td>is the event type to log. </td></tr>
    <tr><td class="paramname">Data</td><td>is the associated data for the event.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ac51c010acb0091ab655be202551c7d14">XV_HdmiTxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ad9c78a413b5caeb99479edc9808799a9">XV_HdmiTxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___hdmi_tx_ss.html#a17215ebaf9a0c87b8fa10c72ae86eb6b">XV_HdmiTxSs::Log</a>, <a class="el" href="struct_x_v___hdmi_tx_ss___log.html#ac6f3a5bc861229dc3ed8868f5afbc1e5">XV_HdmiTxSs_Log::TailIndex</a>, and <a class="el" href="xv__hdmitxss_8h.html#aef570d7b5f53958b25121d5be8e6923faf3507fec8d35951f98bb567d793b2186">XV_HDMITXSS_LOG_EVT_DUMMY</a>.</p>

<p>Referenced by <a class="el" href="xv__hdmitxss_8h.html#a7236081f867771f94ce80eb933e013be">XV_HdmiTxSs_AudioMute()</a>, <a class="el" href="xv__hdmitxss_8h.html#abae6c5dd6d24770d6bfcf76f1208f8d7">XV_HdmiTxSs_Reset()</a>, <a class="el" href="xv__hdmitxss_8h.html#af1a2f31b3f929a0ca3c5fc40fc9c2844">XV_HdmiTxSs_SetAudioChannels()</a>, <a class="el" href="xv__hdmitxss_8h.html#a893af41ef8123dbcc6c697e211656d6e">XV_HdmiTxSs_SetStream()</a>, <a class="el" href="xv__hdmitxss_8h.html#a0cd85322455f42110b3e3bcdf3dc5f15">XV_HdmiTxSs_Start()</a>, <a class="el" href="xv__hdmitxss_8h.html#a592e3853bad0e5476e08909a492606d5">XV_HdmiTxSs_Stop()</a>, <a class="el" href="xv__hdmitxss_8h.html#ad337fa609416bcc5d642d9801885b1e5">XV_HdmiTxSs_StreamStart()</a>, <a class="el" href="group__v__hdmitxss.html#ga23588544c59439321e952b7b4a2c6445">XV_HdmiTxSs_SubcoreInitHdmiTx()</a>, and <a class="el" href="group__v__hdmitxss.html#ga2c1e0df6df7d8d7618d3bdde8eb86923">XV_HdmiTxSs_SubcoreInitVtc()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
